JBoss Community Archive (Read Only)

RHQ

Script - Server

Overview

Internal Name:

Script Server

Description:

A resource with a command line executable or script as its management interface

Singleton:

no

Plugin:

Script

Connection Settings

Name

Description

Required

Internal Name

Executable

The full path to the command line executable or script

yes

executable

Working Directory

When the executable is invoked, this will be its working directory.

no

workingDirectory

Environment Variables

Environment variables that are set when executing the executable

no

environmentVariables

Availability Execute Check

If specified and true, the ability to successfully execute the executable can determine whether or not the managed resource is considered up and available. If you set this to true, you normally do not set the availability regex settings in order to allow availability to be determined based solely on the successful execution, regardless of the exit code or output. If this is false, setting one of the avail regex settings will override it as if it were true.

no

availabilityExecuteCheck

Availability Exit Code Regex

If specified, the executable must return an exit code that matches this regular expression if the managed resource is to be considered up and available

no

availabilityExitCodeRegex

Availability Output Regex

If specified, the executable must output text that matches this regular expression if the managed resource is to be considered up and available

no

availabilityOutputRegex

Availability Arguments

If the executable needs to be executed in order to determine availability, these are the arguments that will be passed to the executable. If you do not specify the regex settings and you set the execute check setting to false, the executable will not be executed and these arguments will not be used - in this case, availability will be determined by the mere existence of the executable file.

no

availabilityArguments

Version Arguments

The arguments to pass to the executable that will help determine the version of the managed resource

no

versionArguments

Version Regex

The regex that can pick out the version from the executable output. If the regex has a captured group, its matched content will be used as the version. If there is no captured group, the entire output will be used as the version.

no

versionRegex

Fixed Version

If specified, this will be the version of the managed resource - the executable will not be invoked to determine it.

no

fixedVersion

Description Arguments

The arguments to pass to the executable that will help determine the managed resource description. This can be arguments to enable verbose version output.

no

descriptionArguments

Description Regex

The regex that can pick out the description from the executable output. If the regex has a captured group, its matched content will be used as the description. If there is no captured group, the entire output will be used as the description.

no

descriptionRegex

Fixed Description

If specified, this will be the description of the managed resource - the executable will not be invoked to determine it.

no

fixedDescription

You must use the internal name to reference properties in Dynamic Group Definition expressions.

Operations

Name

Description

Execute

Executes the executable with a set of arguments and returns the output and exit code.

JBoss.org Content Archive (Read Only), exported from JBoss Community Documentation Editor at 2020-03-11 13:22:30 UTC, last content change 2012-05-09 12:38:54 UTC.